<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright 2001-2004 The Apache Software Foundation.<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<span class="sourceLineNo">005</span> * you may not use this file except in compliance with the License.<a name="line.5"></a>
<span class="sourceLineNo">006</span> * You may obtain a copy of the License at<a name="line.6"></a>
<span class="sourceLineNo">007</span> *<a name="line.7"></a>
<span class="sourceLineNo">008</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<span class="sourceLineNo">011</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<span class="sourceLineNo">012</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<span class="sourceLineNo">013</span> * See the License for the specific language governing permissions and<a name="line.13"></a>
<span class="sourceLineNo">014</span> * limitations under the License.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.commons.logging.impl;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.apache.commons.logging.Log;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.commons.logging.LogConfigurationException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.commons.logging.LogFactory;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.slf4j.Logger;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.slf4j.LoggerFactory;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.slf4j.spi.LocationAwareLogger;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.ArrayList;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Enumeration;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Hashtable;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.List;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.concurrent.ConcurrentMap;<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span>/**<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Concrete subclass of {@link LogFactory} which always delegates to the<a name="line.35"></a>
<span class="sourceLineNo">036</span> * {@link LoggerFactory org.slf4j.LoggerFactory} class.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * <a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;p&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * This factory generates instances of {@link SLF4JLog}. It will remember<a name="line.39"></a>
<span class="sourceLineNo">040</span> * previously created instances for the same name, and will return them on<a name="line.40"></a>
<span class="sourceLineNo">041</span> * repeated requests to the &lt;code&gt;getInstance()&lt;/code&gt; method.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * <a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;p&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> * This implementation ignores any configured attributes.<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;/p&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> * <a name="line.46"></a>
<span class="sourceLineNo">047</span> * @author Rod Waldhoff<a name="line.47"></a>
<span class="sourceLineNo">048</span> * @author Craig R. McClanahan<a name="line.48"></a>
<span class="sourceLineNo">049</span> * @author Richard A. Sitze<a name="line.49"></a>
<span class="sourceLineNo">050</span> * @author Ceki G&amp;uuml;lc&amp;uuml;<a name="line.50"></a>
<span class="sourceLineNo">051</span> */<a name="line.51"></a>
<span class="sourceLineNo">052</span>@SuppressWarnings("rawtypes")<a name="line.52"></a>
<span class="sourceLineNo">053</span>public class SLF4JLogFactory extends LogFactory {<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>    // ----------------------------------------------------------- Constructors<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span>    /**<a name="line.57"></a>
<span class="sourceLineNo">058</span>     * The {@link org.apache.commons.logging.Log}instances that have already been<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * created, keyed by logger name.<a name="line.59"></a>
<span class="sourceLineNo">060</span>     */<a name="line.60"></a>
<span class="sourceLineNo">061</span>    ConcurrentMap&lt;String, Log&gt; loggerMap;<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span>    /**<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * Public no-arguments constructor required by the lookup mechanism.<a name="line.64"></a>
<span class="sourceLineNo">065</span>     */<a name="line.65"></a>
<span class="sourceLineNo">066</span>    public SLF4JLogFactory() {<a name="line.66"></a>
<span class="sourceLineNo">067</span>        loggerMap = new ConcurrentHashMap&lt;String, Log&gt;();<a name="line.67"></a>
<span class="sourceLineNo">068</span>    }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span>    // ----------------------------------------------------- Manifest Constants<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span>    /**<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * The name of the system property identifying our {@link Log}implementation<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * class.<a name="line.74"></a>
<span class="sourceLineNo">075</span>     */<a name="line.75"></a>
<span class="sourceLineNo">076</span>    public static final String LOG_PROPERTY = "org.apache.commons.logging.Log";<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span>    // ----------------------------------------------------- Instance Variables<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span>    /**<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * Configuration attributes.<a name="line.81"></a>
<span class="sourceLineNo">082</span>     */<a name="line.82"></a>
<span class="sourceLineNo">083</span>    protected Hashtable attributes = new Hashtable();<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span>    // --------------------------------------------------------- Public Methods<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span>    /**<a name="line.87"></a>
<span class="sourceLineNo">088</span>     * Return the configuration attribute with the specified name (if any), or<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * &lt;code&gt;null&lt;/code&gt; if there is no such attribute.<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * <a name="line.90"></a>
<span class="sourceLineNo">091</span>     * @param name<a name="line.91"></a>
<span class="sourceLineNo">092</span>     *          Name of the attribute to return<a name="line.92"></a>
<span class="sourceLineNo">093</span>     */<a name="line.93"></a>
<span class="sourceLineNo">094</span>    public Object getAttribute(String name) {<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span>        return (attributes.get(name));<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span>    }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span>    /**<a name="line.100"></a>
<span class="sourceLineNo">101</span>     * Return an array containing the names of all currently defined configuration<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * attributes. If there are no such attributes, a zero length array is<a name="line.102"></a>
<span class="sourceLineNo">103</span>     * returned.<a name="line.103"></a>
<span class="sourceLineNo">104</span>     */<a name="line.104"></a>
<span class="sourceLineNo">105</span>    @SuppressWarnings("unchecked")<a name="line.105"></a>
<span class="sourceLineNo">106</span>    public String[] getAttributeNames() {<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span>        List&lt;String&gt; names = new ArrayList&lt;String&gt;();<a name="line.108"></a>
<span class="sourceLineNo">109</span>        Enumeration&lt;String&gt; keys = attributes.keys();<a name="line.109"></a>
<span class="sourceLineNo">110</span>        while (keys.hasMoreElements()) {<a name="line.110"></a>
<span class="sourceLineNo">111</span>            names.add((String) keys.nextElement());<a name="line.111"></a>
<span class="sourceLineNo">112</span>        }<a name="line.112"></a>
<span class="sourceLineNo">113</span>        String results[] = new String[names.size()];<a name="line.113"></a>
<span class="sourceLineNo">114</span>        for (int i = 0; i &lt; results.length; i++) {<a name="line.114"></a>
<span class="sourceLineNo">115</span>            results[i] = (String) names.get(i);<a name="line.115"></a>
<span class="sourceLineNo">116</span>        }<a name="line.116"></a>
<span class="sourceLineNo">117</span>        return (results);<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span>    }<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span>    /**<a name="line.121"></a>
<span class="sourceLineNo">122</span>     * Convenience method to derive a name from the specified class and call<a name="line.122"></a>
<span class="sourceLineNo">123</span>     * &lt;code&gt;getInstance(String)&lt;/code&gt; with it.<a name="line.123"></a>
<span class="sourceLineNo">124</span>     * <a name="line.124"></a>
<span class="sourceLineNo">125</span>     * @param clazz<a name="line.125"></a>
<span class="sourceLineNo">126</span>     *          Class for which a suitable Log name will be derived<a name="line.126"></a>
<span class="sourceLineNo">127</span>     * <a name="line.127"></a>
<span class="sourceLineNo">128</span>     * @exception LogConfigurationException<a name="line.128"></a>
<span class="sourceLineNo">129</span>     *              if a suitable &lt;code&gt;Log&lt;/code&gt; instance cannot be returned<a name="line.129"></a>
<span class="sourceLineNo">130</span>     */<a name="line.130"></a>
<span class="sourceLineNo">131</span>    public Log getInstance(Class clazz) throws LogConfigurationException {<a name="line.131"></a>
<span class="sourceLineNo">132</span>        return (getInstance(clazz.getName()));<a name="line.132"></a>
<span class="sourceLineNo">133</span>    }<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span>    /**<a name="line.135"></a>
<span class="sourceLineNo">136</span>     * &lt;p&gt;<a name="line.136"></a>
<span class="sourceLineNo">137</span>     * Construct (if necessary) and return a &lt;code&gt;Log&lt;/code&gt; instance, using<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * the factory's current set of configuration attributes.<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * &lt;/p&gt;<a name="line.139"></a>
<span class="sourceLineNo">140</span>     * <a name="line.140"></a>
<span class="sourceLineNo">141</span>     * @param name<a name="line.141"></a>
<span class="sourceLineNo">142</span>     *          Logical name of the &lt;code&gt;Log&lt;/code&gt; instance to be returned<a name="line.142"></a>
<span class="sourceLineNo">143</span>     *          (the meaning of this name is only known to the underlying logging<a name="line.143"></a>
<span class="sourceLineNo">144</span>     *          implementation that is being wrapped)<a name="line.144"></a>
<span class="sourceLineNo">145</span>     * <a name="line.145"></a>
<span class="sourceLineNo">146</span>     * @exception LogConfigurationException<a name="line.146"></a>
<span class="sourceLineNo">147</span>     *              if a suitable &lt;code&gt;Log&lt;/code&gt; instance cannot be returned<a name="line.147"></a>
<span class="sourceLineNo">148</span>     */<a name="line.148"></a>
<span class="sourceLineNo">149</span>    public Log getInstance(String name) throws LogConfigurationException {<a name="line.149"></a>
<span class="sourceLineNo">150</span>        Log instance = loggerMap.get(name);<a name="line.150"></a>
<span class="sourceLineNo">151</span>        if (instance != null) {<a name="line.151"></a>
<span class="sourceLineNo">152</span>            return instance;<a name="line.152"></a>
<span class="sourceLineNo">153</span>        } else {<a name="line.153"></a>
<span class="sourceLineNo">154</span>            Log newInstance;<a name="line.154"></a>
<span class="sourceLineNo">155</span>            Logger slf4jLogger = LoggerFactory.getLogger(name);<a name="line.155"></a>
<span class="sourceLineNo">156</span>            if (slf4jLogger instanceof LocationAwareLogger) {<a name="line.156"></a>
<span class="sourceLineNo">157</span>                newInstance = new SLF4JLocationAwareLog((LocationAwareLogger) slf4jLogger);<a name="line.157"></a>
<span class="sourceLineNo">158</span>            } else {<a name="line.158"></a>
<span class="sourceLineNo">159</span>                newInstance = new SLF4JLog(slf4jLogger);<a name="line.159"></a>
<span class="sourceLineNo">160</span>            }<a name="line.160"></a>
<span class="sourceLineNo">161</span>            Log oldInstance = loggerMap.putIfAbsent(name, newInstance);<a name="line.161"></a>
<span class="sourceLineNo">162</span>            return oldInstance == null ? newInstance : oldInstance;<a name="line.162"></a>
<span class="sourceLineNo">163</span>        }<a name="line.163"></a>
<span class="sourceLineNo">164</span>    }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span>    /**<a name="line.166"></a>
<span class="sourceLineNo">167</span>     * Release any internal references to previously created<a name="line.167"></a>
<span class="sourceLineNo">168</span>     * {@link org.apache.commons.logging.Log}instances returned by this factory.<a name="line.168"></a>
<span class="sourceLineNo">169</span>     * This is useful in environments like servlet containers, which implement<a name="line.169"></a>
<span class="sourceLineNo">170</span>     * application reloading by throwing away a ClassLoader. Dangling references<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * to objects in that class loader would prevent garbage collection.<a name="line.171"></a>
<span class="sourceLineNo">172</span>     */<a name="line.172"></a>
<span class="sourceLineNo">173</span>    public void release() {<a name="line.173"></a>
<span class="sourceLineNo">174</span>        // This method is never called by jcl-over-slf4j classes. However,<a name="line.174"></a>
<span class="sourceLineNo">175</span>        // in certain deployment scenarios, in particular if jcl-over-slf4j.jar<a name="line.175"></a>
<span class="sourceLineNo">176</span>        // is<a name="line.176"></a>
<span class="sourceLineNo">177</span>        // in the the web-app class loader and the official commons-logging.jar is<a name="line.177"></a>
<span class="sourceLineNo">178</span>        // deployed in some parent class loader (e.g. commons/lib), then it is<a name="line.178"></a>
<span class="sourceLineNo">179</span>        // possible<a name="line.179"></a>
<span class="sourceLineNo">180</span>        // for the parent class loader to mask the classes shipping in<a name="line.180"></a>
<span class="sourceLineNo">181</span>        // jcl-over-slf4j.jar.<a name="line.181"></a>
<span class="sourceLineNo">182</span>        System.out.println("WARN: The method " + SLF4JLogFactory.class + "#release() was invoked.");<a name="line.182"></a>
<span class="sourceLineNo">183</span>        System.out.println("WARN: Please see http://www.slf4j.org/codes.html#release for an explanation.");<a name="line.183"></a>
<span class="sourceLineNo">184</span>        System.out.flush();<a name="line.184"></a>
<span class="sourceLineNo">185</span>    }<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span>    /**<a name="line.187"></a>
<span class="sourceLineNo">188</span>     * Remove any configuration attribute associated with the specified name. If<a name="line.188"></a>
<span class="sourceLineNo">189</span>     * there is no such attribute, no action is taken.<a name="line.189"></a>
<span class="sourceLineNo">190</span>     * <a name="line.190"></a>
<span class="sourceLineNo">191</span>     * @param name<a name="line.191"></a>
<span class="sourceLineNo">192</span>     *          Name of the attribute to remove<a name="line.192"></a>
<span class="sourceLineNo">193</span>     */<a name="line.193"></a>
<span class="sourceLineNo">194</span>    public void removeAttribute(String name) {<a name="line.194"></a>
<span class="sourceLineNo">195</span>        attributes.remove(name);<a name="line.195"></a>
<span class="sourceLineNo">196</span>    }<a name="line.196"></a>
<span class="sourceLineNo">197</span><a name="line.197"></a>
<span class="sourceLineNo">198</span>    /**<a name="line.198"></a>
<span class="sourceLineNo">199</span>     * Set the configuration attribute with the specified name. Calling this with<a name="line.199"></a>
<span class="sourceLineNo">200</span>     * a &lt;code&gt;null&lt;/code&gt; value is equivalent to calling<a name="line.200"></a>
<span class="sourceLineNo">201</span>     * &lt;code&gt;removeAttribute(name)&lt;/code&gt;.<a name="line.201"></a>
<span class="sourceLineNo">202</span>     * <a name="line.202"></a>
<span class="sourceLineNo">203</span>     * @param name<a name="line.203"></a>
<span class="sourceLineNo">204</span>     *          Name of the attribute to set<a name="line.204"></a>
<span class="sourceLineNo">205</span>     * @param value<a name="line.205"></a>
<span class="sourceLineNo">206</span>     *          Value of the attribute to set, or &lt;code&gt;null&lt;/code&gt; to remove<a name="line.206"></a>
<span class="sourceLineNo">207</span>     *          any setting for this attribute<a name="line.207"></a>
<span class="sourceLineNo">208</span>     */<a name="line.208"></a>
<span class="sourceLineNo">209</span>    @SuppressWarnings("unchecked")<a name="line.209"></a>
<span class="sourceLineNo">210</span>    public void setAttribute(String name, Object value) {<a name="line.210"></a>
<span class="sourceLineNo">211</span><a name="line.211"></a>
<span class="sourceLineNo">212</span>        if (value == null) {<a name="line.212"></a>
<span class="sourceLineNo">213</span>            attributes.remove(name);<a name="line.213"></a>
<span class="sourceLineNo">214</span>        } else {<a name="line.214"></a>
<span class="sourceLineNo">215</span>            attributes.put(name, value);<a name="line.215"></a>
<span class="sourceLineNo">216</span>        }<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span>    }<a name="line.218"></a>
<span class="sourceLineNo">219</span>}<a name="line.219"></a>




























































</pre>
</div>
</body>
</html>
